/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.idea.gradle.structure.model

import com.android.tools.idea.gradle.structure.configurables.PsContext
import com.android.tools.idea.gradle.structure.configurables.issues.GoToPathLinkHandler
import com.android.tools.idea.gradle.structure.navigation.Places
import com.intellij.ui.navigation.Place

/**
 * A navigation path base don UI places.
 */
abstract class PsPlaceBasedPath : PsPath {
  /**
   * Populate [place] with nagigation path items.
   */
  abstract fun queryPlace(place: Place, context: PsContext)

  fun getPlaceDestination(context: PsContext): Place {
    val place = Place()
    queryPlace(place, context)
    return place
  }

  override fun getHyperlinkDestination(context: PsContext): String? {
    val place = getPlaceDestination(context)
    return GoToPathLinkHandler.GO_TO_PATH_TYPE + Places.serialize(place)
  }
}
